Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Document setting up command completion for logcli #7325

Merged
merged 4 commits into from
Oct 5, 2022

Conversation

dbirks
Copy link
Contributor

@dbirks dbirks commented Oct 3, 2022

What this PR does / why we need it:

This documents the existing command completion that kingpin provides (docs here on that).

Which issue(s) this PR fixes:
Fixes #2949

Special notes for your reviewer:

Please feel free to adjust/reword any of this! I thought I would give it a shot. I ran make docs too, and confirmed the formatting looked good. Hugo even indented the code blocks under the bullet points. 😮

Checklist

  • Reviewed the CONTRIBUTING.md guide
  • Documentation added
  • Tests updated
  • CHANGELOG.md updated
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/upgrading/_index.md

@CLAassistant
Copy link

CLAassistant commented Oct 3, 2022

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Oct 3, 2022
@dbirks dbirks requested a review from a team as a code owner October 3, 2022 23:16
To see if this error is consistent:

```
+ make BUILD_IN_CONTAINER=false validate-example-configs
...
Validating provided example config: ./docs/sources/configuration/examples/bos-config.yaml
bash: ./cmd/loki/loki: Text file busy
```
Seeing if this error is consistent, since I can't reproduce locally:
```
--- FAIL: TestSingleBinaryIngestQuery (0.01s)
    loki_single_binary_test.go:28:
        	Error Trace:	/src/loki/integration/loki_single_binary_test.go:28
        	Error:      	Received unexpected error:
        	            	error starting component all: error initialising module: server: listen tcp :45253: bind: address already in use
        	Test:       	TestSingleBinaryIngestQuery
```
@grafanabot
Copy link
Collaborator

./tools/diff_coverage.sh ../loki-main/test_results.txt test_results.txt ingester,distributor,querier,querier/queryrange,iter,storage,chunkenc,logql,loki

Change in test coverage per package. Green indicates 0 or positive change, red indicates that test coverage for a package fell.

+           ingester	0%
+        distributor	0%
+            querier	0%
+ querier/queryrange	0.1%
+               iter	0%
+            storage	0%
+           chunkenc	0%
+              logql	0%
+               loki	0%

Copy link
Contributor

@MichelHollands MichelHollands left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and I've added it to my .zshrc :). Thanks for adding this.

@MichelHollands MichelHollands merged commit 5465aaf into grafana:main Oct 5, 2022
@dbirks dbirks deleted the docs/logcli-command-completion branch October 5, 2022 17:13
lxwzy pushed a commit to lxwzy/loki that referenced this pull request Nov 7, 2022
This documents the existing command completion that kingpin provides
(docs
[here](https://github.com/alecthomas/kingpin#bashzsh-shell-completion)
on that).

**Which issue(s) this PR fixes**:
Fixes grafana#2949
changhyuni pushed a commit to changhyuni/loki that referenced this pull request Nov 8, 2022
This documents the existing command completion that kingpin provides
(docs
[here](https://github.com/alecthomas/kingpin#bashzsh-shell-completion)
on that).

**Which issue(s) this PR fixes**:
Fixes grafana#2949
Abuelodelanada pushed a commit to canonical/loki that referenced this pull request Dec 1, 2022
This documents the existing command completion that kingpin provides
(docs
[here](https://github.com/alecthomas/kingpin#bashzsh-shell-completion)
on that).

**Which issue(s) this PR fixes**:
Fixes grafana#2949
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/S type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support cli autocompletion to logcli
4 participants